/*
 * Copyright 2017-2021 original authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.micronaut.context.annotation;

import io.micronaut.core.annotation.AnnotationUtil;
import io.micronaut.core.annotation.Experimental;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Allows importing an already compiled set of beans, placing any generating beans relative to the class
 * where the import annotation is defined.
 *
 * <p>Note that this annotation is likely to require more use of reflection if package protected members require injection.</p>
 *
 * @author graemerocher
 * @since 3.0.0
 */
@Experimental
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Import {
    /**
     * @return The classes to import.
     */
    Class<?>[] classes() default {};

    /**
     * A list of package names to import.
     *
     * <p>Note that only types with a bean defining annotation will be imported.</p>
     *
     * @return The packages to import.
     */
    String[] packages() default {};

    /**
     * The annotation types to include in a search when specifying the {@link #packages()} attribute (this attribute has no effect when combined with {@link #classes()}).
     *
     * <p>If set to {@code "*"} will include all non-abstract classes. Defaults to only included types annotated with JSR-330 scopes or qualifiers.</p>
     *
     * @return The annotation types
     */
    String[] annotated() default { AnnotationUtil.SCOPE, AnnotationUtil.QUALIFIER };
}
